home *** CD-ROM | disk | FTP | other *** search
/ Acorn RISC PD-CD 1 / Acorn RISC PD-CD 1.iso / utilities / _customise / dustbins / _blakhole2 / _help < prev    next >
Encoding:
Text File  |  1993-07-25  |  42.6 KB  |  840 lines

  1.  
  2.                                  BLACK HOLE II
  3.                                 ===============
  4.  
  5. Introduction
  6. ============
  7.  
  8. Black Hole was written to provide quick and easy ways of doing some of the
  9. more tedious jobs under RISC OS. It started life as a wastebin, but then
  10. whenever I found a job I wanted an application for, I added it to Black Hole.
  11.  
  12. Black Hole provides the following:
  13.  * A quick and easy way of deleting files. All of the wipe options can be set
  14.    from within Black Hole.
  15.  * It provides wipe features not normally available, such as the ability to
  16.    retain directories.
  17.  * It can be configured to keep a backup copy of any file it deletes, for a
  18.    specified length of time. This is for those of you who delete things by
  19.    accident. I know I do, but then I've got a screw well and truly undone.
  20.    Wibble.
  21.  * All operations are carried out in the background as much as possible. This
  22.    means you can get on with other things while BlackHole grinds away at your
  23.    disc.
  24.  * It provides a facility for saving files from desktop applications into
  25.    specified directories.
  26.  * It contains a file find utility. A very nice file find utilty, in fact. If
  27.    quantity of code were any measure of relative importance, Black Hole would
  28.    be a file-finder with an add-on wastebin. But it wasn't intended like that.
  29.    Wibble.
  30.  * It puts a nice sprite on your iconbar which spins round or indulges in some
  31.    other needless but rather fun activity.
  32.  * It contains a bit for disposing of the junk that lots of applications leave
  33.    hanging around in your module area.
  34.  * Black Hole is fully compatible with Acorn's !Help. For those of you who don't
  35.    want to read any more of this rubbish.
  36.  
  37. Black Hole has many features. Do not be put off if it appears complicated,
  38. it's actually very simple, and you don't need to understand most of it anyway. 
  39. Most of the rest of this Help file is more coherent than it has been so far. All
  40. the explanations are perfectly clear. Any inability to understand them is purely
  41. the fault of the reader and the author accepts no criticisms of his grammar.
  42. She's a very nice old lady. Wibble.
  43.  
  44. **************************** I M P O R T A N T ******************************
  45.  
  46. All wastebin programs need somewhere to store their rubbish. Some wastebin
  47. programs incorporate the rubbish as part of the code. This author prefers to
  48. let users supply their own rubbish. Such user-interactiveness is part of what
  49. makes life worth living. Or something. To store rubbish, Black Hole requires a
  50. directory which is imaginatively called the 'Bin Directory'. Normally this is
  51. the directory !BlakHole2.BlackHole, but may have been changed by the person
  52. who gave you the program. If this is the case, then Black Hole will
  53. probably report an error the first time it is run informing you that the
  54. Bin Directory cannot be found. What it then does is to revert to the default
  55. Bin Directory and save this to disc so that the error does not occur again.
  56. See below for more information about the Bin Directory. If you simply cannot
  57. get the program to run (a very, very unlikely probability) then check that
  58. the application contains all the files described at the end of this file, and
  59. try deleting the files 'Options' and 'SaveOpts'.
  60.  
  61. *****************************************************************************
  62.  
  63.                             The Bin Directory
  64.                            -------------------
  65.  
  66. A few words about this may be useful. Then again, they may not. But you never
  67. know unless you try.
  68.  
  69. 1) Files copied to the bin directory are placed in a subdirectory called
  70. xxxx_yy_zz where xxxx is the year (eg 1993) ,yy is the month and zz is the
  71. day of the month. Clicking Select over the iconbar icon opens the directory for 
  72. today if it exists, otherwise the root bin directory is opened.
  73.  
  74.   **************************************************************************
  75.   **                       New Bin Directory Format                       **
  76.   ** NOTE -  this has changed from versions prior to 1.15, where the year **
  77.   ** came last. With the date this way round, the directories appear in   **
  78.   ** cronological order in the filer window and the menu, which is much   **
  79.   ** prettier. (Thank you James Miller).                                  **
  80.   ** If your bin directory contains any subdirectories in the old format, **
  81.   ** Black Hole will give you the option to convert them into the new     **
  82.   ** format. If you select 'NO' to this option, then no auto-deletion will**
  83.   ** not take place. This will only happen if you have auto-deletion ON.  **
  84.   ** I'll explain what auto-deletion means later. Promise.                **
  85.   **************************************************************************
  86.  
  87. 2) When copying to the bin directory, Black Hole will go by the fastest
  88. possible route - i.e. it will rename files if possible as this is faster than
  89. copying and then deleting. However, if 'Force' is not set, then Black Hole
  90. must first copy and then delete files as Rename ignores the access status
  91. of files. This results in two Filer Action windows appearing one after the
  92. other.
  93.  
  94. 3) Any files or directories placed in the ROOT bin directory which do not
  95. have names of the form "xxxx_yy_zz" will be deleted next time Black Hole
  96. is run.
  97.  
  98. 4) If you have Andrew Hersee's Filer2 and the WimpSprite module, then the
  99. current bin directory will be represented by a picture of a dustbin in the
  100. bin directory filer window. This is utterly pointless, but it gives you another
  101. reason to use Black Hole.
  102.  
  103. ----------------------------------------------------------------------------
  104.  
  105. Get on with it man!
  106.  
  107. Pressing the menu button over the BlackHole icon produces a standard menu
  108. with several options:
  109.  
  110. Info      ==> Leads to a window containing information about the program.
  111.  
  112. Config..      Opens a window containing the configuration. Files and
  113.               directories dragged to the BlackHole icon will be wiped subject
  114.               to these options. There are also options for controlling other
  115.               aspects of the program. See below for an explanation.
  116.               The Options window can also be opened by pressing the right
  117.               mouse button over the iconbar icon.
  118.  
  119. Contents  ==> Leads to a submenu allowing you to perform five operations on
  120.               the contents of the Bin Directory.
  121.               These five options all have a submenu. This contains the entry
  122.               'All' followed by the names of any subdirectories set up for
  123.               one day's working. Selecting All makes the action apply to the
  124.               whole bin. Selecting one directory applies to only that day. 
  125.               Clicking on the entry in the Contents menu is equivalent to
  126.               selecting 'All'.
  127.               If the bin directory is empty, this entry will appear in light
  128.               grey and will read "No Contents"
  129.               Destroy    : Unconditionally wipes everything. There is a
  130.                            confirmation window before this happens.
  131.               Count      : Counts the contents.
  132.               Info       : Reads the contents of the Bin and displays their
  133.                            names, sizes, and types in a window. Clicking SELECT
  134.                            on a filename in this window will open the parent
  135.                            directory of that file. Cliking MENU opens a menu
  136.                            like that described below under 'File Finder'.
  137.               Squash     : Uses the RISC OS 3 Squash module to compress all
  138.                            the files in the bin, thus making them take up
  139.                            less disc space. The file 'Squash' from inside
  140.                            the !Squash application must be present in the
  141.                            current library (ie %) (see user guide under
  142.                            library).
  143.               Open       : Will open the bin directory selected from the
  144.                            submenu. Selecting 'All' will open all the 
  145.                            subdirectories.
  146.               The memory allocated to the menu of subdirectories is sufficient
  147.               for 40, which should be adequate for most people. Any more
  148.               directories will be ignored.
  149.  
  150. Wipe Drive==> Leads to a window containing the names of any adfs floppy
  151.               drives fitted, and also the RAM disc, if present. Selecting one
  152.               of these will cause the disc in the selected drive to be wiped
  153.               of all its contents. There is a confirmation window before this
  154.               happens, where clicking on 'No' will abort the operation.
  155.               If you want to rename the disc, the new name can be entered
  156.               in the submenu off this menu. Leaving this submenu blank will
  157.               keep the same name for the disc. This menu will also
  158.               recognise Brian Brunswick's MemFS filer if it is present.
  159.  
  160. Auto Saver..  Opens the Auto File Saver window. See below for an explanation
  161.               of this feature.
  162.  
  163. Find File ... Opens the File Finder window, which can be used to search
  164.               a directory structure for all files of a particular name
  165.               or type. See below for a fuller explanation.
  166.  
  167. Module Kill > See below for an explanation of this rather violent sounding
  168.               option.
  169.  
  170. Quit          Quits the Black Hole
  171.  
  172. -----------------------------------------------------------------------------
  173.  
  174. The Config Window:
  175. ==================
  176.  
  177. This window is divided into two sections. The options are contained within
  178. the scrollable section of the window. The outside portion of the window
  179. contains two buttons - click OK to close the window, or Save to store the
  180. current settings as permanent defaults. You can also drag the resize box to
  181. alter the height of the window. This will stop people with large screen modes
  182. (and strange squinty eyes) from complaining, which happened quite a lot. But
  183. then, you'd complain if you couldn't read your screen properly. I LIKE mode 27.
  184.  
  185. The scrollable panel is divided into four sections. These are:
  186.  
  187.  Default Wipe Options:
  188.  ---------------------
  189.   These icons control the way Black Hole deletes files dragged to its icon.
  190.   Black Hole uses the standard RISC OS 3 Filer Action window so that a Black
  191.   Hole wipe operation will appear the same as any other desktop delete
  192.   operation.
  193.  
  194.   Confirm: 
  195.    Prompts for confirmation of all deletions.
  196.  
  197.   Force:
  198.    Forces deletion of locked objects.
  199.  
  200.   Verbose:
  201.    Displays information on each object deleted.
  202.                
  203.   Retain Structure:
  204.    If this icon is selected, then only directory contents will be deleted.
  205.    All directories will remain intact, even if empty.
  206.  
  207.  Copy Options:
  208.  -------------
  209.    These icons control the wastebin aspect of Black Hole.
  210.  
  211.   Retain Copies:
  212.    Turning this off disables the wastebin aspect of Black Hole - ie it will
  213.    not copy any files to its bin directory.
  214.    Dragging a file or selection of files to the Black Hole while holding down
  215.    Ctrl will turn this option off for those files.
  216.    
  217.   Delete Copies After:
  218.    If you use 'Retain Copies', then files are not actually deleted, they are
  219.    just moved into the Bin directory where they will remain until you do
  220.    something about it. This option allows Black Hole to do something about it
  221.    for you. If you select this option, then files in the Bin Directory will
  222.    be kept there for the specified number of days, then deleted for good.
  223.  
  224.   Squash on Shutdown:
  225.    Retained copies can take up a lot of disc space, and it is helpful if you
  226.    can compress them. This option allows Black Hole to do this for you. When 
  227.    this option is selected and you do a 'Shutdown' of the desktop (i.e. 
  228.    Ctrl-Shift-F12), Black Hole will go through today's bin and Squash all its
  229.    contents before allowing the desktop to shut down. It will only do this if
  230.    something has been added to the bin. Cute, innit? This option also applies if
  231.    you select 'Quit' from Black Hole's iconbar menu. The file 'Squash' from
  232.    inside the !Squash application must be present in the current library for
  233.    this to operate. Note that this does not mean you have to take a printout
  234.    of the file to the big building down the road with all the books in. Oh no.
  235.    You can get someone to do that bit for you. And if you beleived that then I
  236.    suggest you look in your user guide under 'Library'. If you can read.
  237.    Wibble.
  238.  
  239.   Bin Location
  240.    The Black Hole Bin directory is, by default, the directory
  241.     !BlakHole2.BlackHole
  242.    but this can be changed if desired. To do this, enter the pathname of the
  243.    directory you wish to use into this box. Pressing RETURN immediately or
  244.    clicking on the OK icon will make your new directory the Bin Directory.
  245.    Dragging a directory to the options window will insert the pathname of
  246.    that directory as the new Bin Directory and make the change current.
  247.    Leaving the box empty will cause the default to be restored.
  248.    Clicking select on the iconbar icon opens the current Bin Directory.
  249.    The 'Empty' or 'Occupied' message below the iconbar icon applies to this
  250.    directory, as does the 'Delete Copies After' option, if the new bin
  251.    location is saved permanently.
  252.  
  253.  Misc:
  254.  -----
  255.   Spin:
  256.    When the pointer is over a BlackHole window or its iconbar icon, the icon
  257.    will spin round. On an ARM 2 in some screen modes this can cause flicker
  258.    which can be irritating. This option is therefore provided for those
  259.    people who don't like their Black Holes to spin.
  260.  
  261.  Clock:
  262.    Turning this on will cause a small digital clock to appear on the iconbar
  263.    next to the pallette icon. This is here for gratuitous showing off reasons
  264.    only and it is accurate only to ± 1 minute or thereabouts. You can also
  265.    select whether to have a 12 or 24 hour clock.
  266.  
  267.   Sprites:
  268.    The iconbar sprites used for the animation of the Black Hole can be
  269.    changed very easily. (Black Hole is supplied with four sets of sprites.)
  270.    Clicking the left button over the arrow next to this option opens a menu
  271.    containing the names of the current sprite files. Select one to change
  272.    the sprites.
  273.    To define your own sprites, you need a sprite file containing nine frames
  274.    of animation named !black0 through !black8 inclusive. Mode 12 sprites
  275.    should be 34 x 17 pixels. Mode 20 sprites should be 34 x 34. Save the
  276.    sprite file into the directory !BlakHole2.Sprites and it will appear on
  277.    the Sprites menu. You can open this directory by clicking on the 'Open
  278.    Dir' icon.
  279.    The standard RISC OS 3 *IconSprites convention is used for these files;
  280.    i.e. the same animation can have low res. (Mode 12), high res. (Mode 20)
  281.    and high res. monochrome sprites defined. The Mode 12 sprites should be
  282.    saved as whatever you want to call them, the mode 20 ones should have the
  283.    same name with a 22 appended. Black Hole will ignore any files ending in
  284.    22 or 23 on its sprite menu, but RISC OS 3 will automatically select the
  285.    correct one for the current mode. The default sprites (BlakHole) are defined
  286.    this way. If you select the 'Update on mode change' option, then Black Hole
  287.    will automatically update its sprites to suit the new resolution when you
  288.    change to a new screen mode, subject to a suitable sprite file being
  289.    available.
  290.  
  291.   Menu Font:
  292.    Selecting this causes Black Hole to use an outline font for the text in
  293.    its menus. In my opinion, these look far nicer than the normal system font
  294.    and as they're built in to RISC OS 3, why shouldn't they be used?
  295.    The fonts definitely look best in a hi-res mode so this icon is provided to
  296.    allow you to turn them off if you don't like them.
  297.    Remember that if you do use fonts, you will need a small font cache - 32K
  298.    is more than adequate.
  299.  
  300.   Clock Font:
  301.    Similar to the above but controls the use of fonts in the iconbar clock.
  302.    Later on I will mention how you can customize Black Hole to use different
  303.    fonts in the menus and the clock. To use the WIMP font turn this icon OFF.
  304.  
  305.  Auto Saver Options:
  306.  -------------------
  307.  These two options refer to the Auto Saver part of Black Hole which is
  308.  described more fully below.
  309.  
  310.  Confirm before Saving:
  311.   This will ask whether you are sure before saving anything. It will also tell
  312.   you if the file already exists.
  313.  
  314.  Open Destination when Saved:
  315.   This will open the destination directory when a file is saved into it using
  316.   the Auto Saver.
  317.  
  318. -----------------------------------------------------------------------------
  319.  
  320. The Auto Saver.
  321. ===============
  322.  
  323. How many times have you started to drag a file from the save box of some
  324. application, only to find you can't see the directory where you want to put 
  325. the file? Never? Skip this bit, it's not for you. All the time? Ahh, then worry
  326. no longer. This bit was written for you (and me). The autosaver allows you to
  327. set up beforehand a list of filetypes and which pathnames to save them to. Then
  328. by dragging the file to the Black Hole from the application's Save As box, it
  329. will be saved to the specified path.
  330.  
  331. To cut a long story marginally less long, an example:
  332.  
  333. Suppose you always save Text files into a directory called
  334. adfs::4.$.Textfiles. Select the Autosaver option from BlackHole and type FFF
  335. (the filetype for text files) in the Filetype box. Type the pathname into the
  336. Destination box. From now on, if you drag a textfile from the "Save as:" box
  337. of Edit (or any application which can output data as a textfile) to the 
  338. BlackHole icon, it will be saved to the specified pathname. (Note: a filename
  339. must be specified in the application's Save As box.) This can be done for any
  340. filetype.
  341. In other words, you can specify a pathname for a particular file type. If you
  342. then 'save' a file of that type 'into' Black Hole, it will stick the specified
  343. pathname in front of the filename and save the file.
  344.  
  345. This only applies when you drag a file FROM THE SAVE BOX OF AN APPLICATION.
  346.  
  347. If you drag a file from a directory viewer to the Autosaver window, it's type
  348. will be inserted in the window. Dragging a directory to the Autosaver window
  349. inserts its pathname.
  350.  
  351. You can also type the name of the file type (eg Text instead of FFF) into the
  352. Filetype box. Clicking on the arrow button next to this icon will open a
  353. filetype menu from which you can select one.
  354.  
  355. If there is no path set up for a filetype dragged to the icon, it will be 
  356. saved to the current Black Hole Bin directory.
  357.  
  358. If you have more than one path set up for one filetype, then the one used 
  359. will be EITHER the one currently displayed in the AutoSaver window (even if 
  360. it is not visible on screen) OR if no path for that filetype is displayed, 
  361. then it will be the one highest in the list.
  362. If a file already exists with the pathname given, it will be overwritten.
  363.  
  364. To make the settings in this window permanent, click on the Save button.
  365.          
  366. -----------------------------------------------------------------------------
  367.  
  368. The File Finder.
  369. ================
  370.  
  371. The file finder can be used to find files (surprise!) and directories (because
  372. I couldn't be bothered telling it not to).
  373. Enter the path you wish to search in the 'Search Path' icon. This directory
  374. and all its subdirectories will be searched for files and directories with
  375. names and/or filetypes matching those specified in the 'Search For:' section.
  376. Multiple search paths (including the names of floppy discs) can be specified
  377. by separating them with a backslash (a "\"). For example, you could enter
  378. adfs::4.$.Apps\adfs::4.$.Games. The filer will prompt for disc insertion if
  379. necessary. I hope.
  380.  
  381. Similarly, you can enter multiple search names in the 'Name(s) :' box. Again
  382. use "\" as a separator. A maximum of 10 names can be entered, and they can
  383. contain wildcards. The wildcards accepted are the standard RISC OS ones - 
  384. # for any one character, * for zero or more characters.
  385.  
  386. If you want to search for one particular file type, this can also be entered.
  387. You can enter either the number (eg AFF) or the name (eg draw) of the filetype.
  388. Unlike earlier versions of this program, the Filetype box is no longer case
  389. sensitive and will now accept, for example, both 'draw' and 'Draw'.
  390. This works both separately and in conjunction with the Name(s). If no type is
  391. entered, all files matching the Name(s) will be listed.
  392.  
  393. Dragging a directory to this window will add it to the path list, putting a
  394. "\" in if one is not already there.
  395. Dragging a file to the window will make the type of that file the current
  396. search type. The filetype menu can be opened by clicking on the arrow icon.
  397.  
  398. The 'size' box allows you to search for files of a particular size, or files
  399. less than or greater than a certain size. The default setting is '>0 bytes'
  400. which will list all files >=0 bytes in size, i.e. everthing. This is useful
  401. if you want to find out which files are taking up all the space on your hard
  402. disc, for instance. You must specify an operator to go with the number, i.e.
  403. <, >, or =. The program will compare the size of the found files (bytes) with
  404. your entry in the size box: <size of file>.<user entry>. If the mathematical
  405. statement is TRUE (ie 50000>400) then the file will be included in the list.
  406. If the statement is mathematically invalid or false (ie 500000<=>=400 or 4>100) 
  407. then the file will be ignored. If you omit an operator, the program inserts
  408. an =. Leaving this box blank makes the program default to >0. You can use other
  409. standard operators, such as AND or NOT, but this will, I imagine, be of
  410. somewhat limited use.
  411.  
  412. The button icons in this window control the following:
  413.  
  414. Case Sensitive:  If this is selected, then the search becomes case sensitive,
  415.                  i.e. entering 'Help' as the filename will find files called
  416.                  'Help' but not 'help'.
  417.                  
  418. Open Viewer:     Will open the directory viewer containing the found file.
  419.  
  420. List Details:    Will list the files found, their types and sizes in a window.
  421.                  Clicking SELECT on a filename in this window will open the
  422.                  parent directory of that file. Clicking MENU over an entry
  423.                  produces a menu with five options:
  424.                  Open Parent               : The same as clicking 'SELECT'
  425.                  Run File/Run App/Open Dir : Context sensitive to the type of
  426.                                              item clicked over.
  427.                  Squash/Unsquash           : Acorn's 'Squash' thingy again.
  428.                                              This only works on files.
  429.                  Bin File/Bin App/Bin Dir  : Perform action on the item exactly
  430.                                              as if it had been dragged to
  431.                                              the iconbar icon. There is a
  432.                                              confirmation window first.
  433.                  Destroy                   : Confirmation window followed by
  434.                                              unconditional deletion.
  435.                  This menu is also available when you do a Contents=>Info from
  436.                  the iconbar menu, except that the 'Bin' option is unavailable.
  437.  
  438. Move to Bin:     This acts only on files, not directories. It will move found 
  439.                  files into the current Bin Directory, overwriting any file
  440.                  already exisiting with that name. Note that this can be rather
  441.                  dangerous, and that because of this there is a confirmation 
  442.                  window before the search actually starts.
  443.  
  444. Fast:            Normally, Black Hole informs you of what it is doing during
  445.                  a search - it shows the directory it is currently searching
  446.                  and the number and total size of files found. Displaying this
  447.                  information slows the program down a tad, so by selecting
  448.                  'Fast' you can stop it wasting its time.
  449.  
  450. Archives:
  451. Under RISC OS, archives cannot be read without the software used to create them.However, David Pilling's 'SparkFS' and Mark Smith's 'ArcFS' both allow archives
  452. to be read like directories and hence to be searched. ArcFS allows you to read
  453. 'Spark' archives, while SparkFS allows a wide range of different archives to be
  454. read. The three icons in this box control what BlackHole does when it encounters
  455. an archive.
  456. 'Ignore' will treat the archive as a file.
  457. 'Use ArcFS' will use ArcFS (if you have it) to access and search Spark archives.
  458. 'Use SparkFS' will use SparkFS (if you have it) to access and search all the
  459. types of archive that your copy of SparkFS is configured to use.
  460. To use these options, the relevant program must be either running or have been
  461. 'seen' by the filer. If SparkFS is running, then 'Use SparkFS' will be the only
  462. option, because that's how SparkFS works - if it's running, archives become
  463. transparent and behave exactly like directories. Allegedly.
  464.  
  465. ('Spark' and 'SparkFS' are copyright David Pilling and have no connection with
  466.  Fat German Productions.)
  467. ('ArcFS' is copyright Mark Smith and has no connection with Fat German
  468.  Productions.)
  469.  
  470. As an example - if you want to search the directories 'adfs::4.$.apps' and
  471. 'adfs::4.$.graphics' for any files of type FFF with names containing 'text':
  472. Type
  473.   adfs::4.$.apps\adfs::4.$.graphics
  474. into the search path box. Type
  475.   *text*
  476. into the Name box and select case sensitivity as appropriate. Now type
  477.   FFF (or Text)
  478. into the type box. Finally hit RETURN or click on GO.
  479.  
  480. The GO button becomes an Abort button for the duration of the search. Clicking
  481. on this button at any time during a search will stop the search and display
  482. the results.
  483.  
  484. If you leave both the name and type boxes blank, then all the files in the
  485. specified search path(s) will be listed - Black Hole defaults to a "*" for
  486. the search name.
  487.  
  488. The number of files found is displayed during the search at the bottom of the
  489. window. Unless you have selected 'Move to Bin', this also includes directories.
  490.  
  491. -----------------------------------------------------------------------------
  492.  
  493. Module Kill.
  494. ============
  495.  
  496. One of the things I find annoying about many applications (Computer Concepts
  497. please note) is that when you quit them they leave all their junk behind in
  498. the RMA. My RISC OS 3 BJ10 turbodriver leaves 8 modules behind. This obviously
  499. uses up a fair proportion of the RMA. This is what Module Kill is all about.
  500. The submenu has three entries. These may be the only entries, or there may be
  501. some more below a dotted line. Whatever. The third entry is 'Name'; Moving 
  502. right off this gives you a writable menu into which you can type the name of a
  503. module. Black Hole will then kill this module. Be careful when doing this!
  504. The second entry is 'Minimize'. When you select this, Black Hole will attempt
  505. to reduce the size of the module area to a minimum. Usually it fails because
  506. the MEMC isn't violent enough. The first option is 'Open Dir', and this is
  507. where the fun starts.
  508.  
  509. Selecting 'Open Dir' opens a directory. Surprised? There may be a few files in
  510. this directory, or there may not be. It doesn't matter. What is this directory
  511. for? Right. What you need to do is to find an application which leaves some
  512. modules behind when you quit it. Do this by pressing F12, typing 'Modules' and
  513. noting the name of the last module in the list. Now return to the desktop, run
  514. then quit your application, and look again at the module list. If the app. has
  515. left any modules behind they will be tacked on the bottom of the list. Make a 
  516. note of the names of these modules.
  517.  
  518. Now go back to the desktop and create a text file (using Edit, say) containing
  519. a list of these module names, one module per line. Save this file, in the
  520. directory you opened from the menu, with a meaningful name. Get the Module Kill
  521. menu up again. Your file will now be on the menu under the dotted line.
  522. Selecting the entry for your file will cause Black Hole to attempt to Kill all
  523. the modules listed in that file, then to minimize the RMA. It is usually
  524. successful at the first bit, but the second bit often causes it problems. Don't
  525. worry, it won't crash (Says he confidently).
  526.  
  527. The dangerous bit is if you use Module Kill while the relevant app. is still
  528. running. My advice is 'Don't - It's not fun.'
  529.  
  530. --------------------------------------------------------------------------------
  531.  
  532. Notes: 
  533. ======
  534.  
  535. 1) Rather than using Squash, which is rather slow, you may like to compress
  536.    your Retained Copies by another method. This is most easily done if you
  537.    own Computer Concept's Compression. You can simply make the Bin Directory
  538.    a CFS directory. Provided CFS is loaded before Black Hole on bootup,
  539.    everything will be OK. This has the added advantage that files are
  540.    compressed as they are added to the bin.
  541.    For example, you could make the bin directory 
  542.      CFS#adfs::IDEDisc4.$.!BlakHole2.BlackHole.
  543.    You can probably do this with SparkFS as well.
  544.  
  545. 2) Dragging the contents of the Bin directory to the iconbar icon WILL delete
  546.    them if force is off, but will not if force is on. This is because force
  547.    MOVES files, but force off copies then deletes. If Retain Copies is off,
  548.    or Ctrl is pressed, then they will be deleted whatever.
  549.  
  550. 3) Black Hole treats DOS partitions as normal directories for all purposes.
  551.    If a DOS partition is deleted with 'Retain Copies' set, then the files are
  552.    retained but in a directory with the same name as the partition, not as
  553.    a partition. This probably applies to archives if SparkFS is running, but I
  554.    haven't tried it so don't quote me.
  555.  
  556. 4) If you want to customize Black Hole to use fonts other than the defaults,
  557.    then load the file 'Messages' into a text editor (eg !Edit) and change the
  558.    relevant lines in there. It's self-explanatory and very easy really, honest.
  559.    Note that the fonts listed in this file will only be applied if the 'Menu
  560.    Font' and/or 'Clock Font' icon in the config window is on.
  561.  
  562. 5) Observant people (those with one or more eyes and a functioning brain) may 
  563.    notice that the file finder searches backwards down a group of directories,
  564.    i.e. if your root directory has five subdirectories such as !Boot, !Fonts,
  565.    !System, !Scrap, and Apps, the file finder will search them in reverse order.
  566.    This is simply because of the way it works and I've not bothered to change it
  567.    because it means that almost everything gets searched before !Fonts, which 
  568.    really doesn't need searching anyway, and so the search can be manually 
  569.    aborted at this point.
  570.  
  571. -----------------------------------------------------------------------------
  572.  
  573. Brief Explanation of Contents of !BlakHole2.
  574. ============================================
  575.  
  576. !Boot and !Run are the usual stuff.
  577.  
  578. !Help is this file.
  579.  
  580. !RunImage, Init, Setup, and Overlay are the program - it's split into chunks so
  581. I can get more program into the same memory.
  582.  
  583. !Sprites and !Sprites22 are the filer sprites.
  584.  
  585. BlackHole is the default bin directory.
  586.  
  587. icons contains the sprites used in the windows.
  588.  
  589. Messages contains the Help Text and other such nonsense.
  590.  
  591. Sprites contains the sprite files for the animation of the iconbar icon. By
  592. default these are BlakHole, BlakHole22, Recycle, Burn, and Shredder.
  593.  
  594. Temp is a directory used when directory structure needs to be retained.
  595.  
  596. Templates are...... the templates!!
  597.  
  598. Options is where the Config. options are saved.
  599.  
  600. Saveopts is the options for the Auto Saver. You can alter this using Edit if
  601. you like, just save a sample file to find out the format.
  602.  
  603. If these last two files are not present, Black Hole will use its own defaults
  604. for all the options.
  605.  
  606. -----------------------------------------------------------------------------
  607.  
  608. Notes - The Sequel (more random ramblings)
  609. ==================
  610.  
  611. This program is far from perfect. The reasons for this are many and varied
  612. and the word 'incompetence' appears in them frequently. A large part of it
  613. is because I learnt to program RISC OS by staring vacantly at other people's
  614. programs until the sugar of understanding began to crystallise in the
  615. syrup of my brain. (Sorry, too much psychedelic music.)
  616. By the way, I can strongly recommend the method of programming I use:
  617. 1) Decide what it is you want to do.
  618. 2) Find a program that already does it.
  619. 3) 'Adapt' the code in that program.
  620. 4) Have a coffee.
  621. This works very successfully and probably explains why I've got three
  622. apparrently identical procedures, each of which is absolutely crucial to the
  623. program. Ho hum.
  624. Please note, however, that this is not an admission of plagiarism. 
  625. Other people's programs are a great source of PRM-type information, and are
  626. usually far more easily understandable than Acorn literature.
  627.  
  628. The next bit of this file is a load of boring pseudo-legal crap which I put
  629. in because everybody else does, so it seemed like a good idea.
  630.  
  631. -----------------------------------------------------------------------------
  632.  
  633. Disclaimer:
  634. ===========
  635.  
  636. This program is supplied 'as is' with no guarantee of its suitability for any
  637. purpose. I will not be held responsible for any loss of data occuring through
  638. the use or misuse of this program. I will also not be held responsible for
  639. anything else you may do after accidentally deleting your valuable files.
  640. If you're worried about losing things, then use 'Retain Copies' - that's what
  641. it's for.
  642. If anything goes wrong with Black Hole please let me know. Preferably gently.
  643. Then peel me off the ceiling and sit me down in fron of my computer with an
  644. intravenous drip of caffeine whilst quitely phoning for an ambulance.
  645.  
  646. -----------------------------------------------------------------------------
  647.  
  648. Public Domain Notice:
  649. =====================
  650.  
  651. Black Hole is released by courtesy of the Fat German in association with the
  652. Great Green Gollywog and his minions. It may be freely copied and used, as long
  653. as the following conditions are met:
  654.  
  655. a) That this notice is distributed unchanged with every copy.
  656. b) That the application is supplied with unchanged versions of all the files
  657.    described above.
  658.    (If you do make modifications to any part of BlackHole, please do not
  659.    distribute them without contacting me first, at the address below.)
  660. c) No charge is made for the distribution. Public domain libraries may make
  661.    a small charge to cover distribution costs. It is highly unethical, not
  662.    to mention dishonest to make a charge for software which programmers
  663.    have intended to be freely distributed, especially if none of that profit
  664.    finds its way to the programmer.
  665. d) That you all smile and have a good time.
  666.  
  667. All copyright is reserved. You may not use any part of this application in
  668. any project which is to be sold for profit without my express permission
  669. in writing.
  670.  
  671. If you wish to use pieces of my code in your own pd programs then please feel
  672. free to do so, provided these programs are not intented for sale.
  673. I say this mainly because my telling you not to do so would not stop you, but
  674. also becasue I learned programming by nicking and splicing bits of other
  675. people's programs, so why shouldn't you?
  676.  
  677. If you do use my code, a credit would be nice. Money would be even better.
  678.  
  679. Anyone out there feeling particularly generous can send me a £5.00 (ono)
  680. registration fee and a disc, (well, actually a disc and a nice letter saying
  681. how wonderful my program is would probably do the trick,) and I will send them
  682. free upgrades whenever I write one, possibly accompanied by any PD applications
  683. I can get my grubby little mitts on. Come to that, a picture of you smiling
  684. contentedly watching the icon spin round would make me very well disposed
  685. towards you. And believe me, you want that. The Black Hole is not merely a
  686. program - it's a living, breathing entity that will become very nasty if you
  687. annoy it and has a very nasty sting. No, hang on, that's a wasp. The Black Hole
  688. is a piece of code which runs in a 64K wimpslot and never crashes unless I
  689. specifically programmed it that way. But that doesn't sound as impressive.
  690. Wibble.
  691.  
  692. -----------------------------------------------------------------------------
  693.      
  694. Thanks go to:
  695. =============
  696.  
  697. All the programmers who unknowingly taught me how to program RISC OS; I've only
  698. just bought my PRMs, so looking at other people's code was the quickest way to
  699. learn.
  700.  
  701. Robin Watts     - The finer details of one or two SYS calls and the 
  702.                   associated routines for extracting the useful data from
  703.                   them were purloined from his excellent !Larger - 'Sticky
  704.                   Backdrop Extraordinaire', which I spend most of my time
  705.                   beta- testing for him. (I've got RISC OS 3, which has a
  706.                   built-in sticky backdrop, but it's crap, so !Larger is a
  707.                   most welcome burden on my hard disc.) Robin was also never
  708.                   too busy to give advice or to let me peruse his PRMs.
  709.                   (Well, hardly ever.....). The routines for doing the Config.
  710.                   window as a composite window also came from Robin.
  711.                   Robin's Addresses are:
  712.                   217 Waterhouse Moor, Harlow, Essex CM18 6BW, OR
  713.                   St. Catherine's College, Manor Road, Oxford OX1 3UJ
  714.                   or by Janet: m90rjw@uk.ac.oxford.ecs
  715.  
  716. James Miller    - Thanks to James for mailing me with a bug in the File Finder
  717.                   and informing me of the existence of the Boot File Creation
  718.                   message. (Why do I always find the bugs the day AFTER I
  719.                   release the software? This must be nature's way of ensuring
  720.                   that software always produces offspring - a new version is
  721.                   always required to fix the bugs in the previous version.
  722.                   Evolution in action!)
  723.  
  724. Emmet Spier     - Emmet's Help file said that he didn't mind people nicking
  725.                   his code, provided he got a credit, so I wholeheartedly and
  726.                   ruthlessly butchered out the code for a filetype menu from
  727.                   his !Set-Type. Then I decided that it took up too much
  728.                   memory so I vastly simplified it to remove the sprites. Then
  729.                   I found a new way of doing it so I put the sprites back in.
  730.                   I can't remember whether any of Emmet's code is still
  731.                   in there, but if it is thanks are due to him.
  732.  
  733. Jason Williams  - For designing the Shredder sprites. Very nice they are too.
  734.  
  735. Mark Kempster   - For the Burn sprites. They're cool. Er, hot.
  736.  
  737. Steve Singer    - I didn't copy any code from Steve, but it was he who
  738.                   complained that he wouldn't even look at my proggy if the
  739.                   iconbar icon didn't spin round. And he also wrote Bloxed, 
  740.                   a game which may be the future cause of failure in Finals
  741.                   for half of St. Catherine' College. He also showed me the
  742.                   NeXT workstation which was running the program which gave
  743.                   me the inspiration for Black Hole. And now he tells me he
  744.                   never uses Wastebin programs.....
  745.  
  746. Dominic Symes   - For writing !Zap, the best editor around. Even if it does
  747.                   crash quite a lot...
  748.  
  749. -----------------------------------------------------------------------------
  750.  
  751. Differences between Black Hole and Black Hole II version 1.16
  752. =============================================================
  753.  
  754. The original Black Hole ran on RISC OS 2 and RISC OS 3. As RISC OS 3 is now
  755. accepted as standard on Acorn machines I decided to make use of some of its
  756. new features in this new version of the program.
  757.  
  758. 1) All Filer operations are now run by Filer_Action. The advantages of this
  759. are:
  760.   i) A dramatic speed increase when deleting large numbers of files.
  761.   ii) Any errors which occur are trapped by the filer and should not crash
  762.   Black Hole as happened very occasionally in the original (I can't think of
  763.   everything.....)
  764.   iii) More than one operation can be carried out simultaneously.
  765. The disadvantages are:
  766.   i) When copying to the bin, Filer_Action ignores the access status of
  767.   files. Thus if Force is off, you still get all the locked files copied
  768.   although they aren't deleted. However, I don't anticipate many people
  769.   using this program with Force off.
  770.   ii) For Retain Structure, the original would simply not delete any
  771.   directories. Filer_Action cannot do this, so the structure has first to be
  772.   copied, then written back once the deletion has finished.
  773.   iii) Copies cannot be squashed as they are copied. This version has a
  774.   Squash option on a menu and an automatic 'Squash on Shutdown' option.
  775.  
  776. 2) The file finder has been dramatically speeded up and Archive compatibililty
  777. included. Wildcarded searches are now possible. Note: This version has been
  778. speeded up relative to versions of BlakHole2 prior to 1.10.
  779.  
  780. 3) DOS partitions are recognised and treated as directories.
  781.  
  782. 4) The bin structure has been changed to have a separate subdirectory for
  783. each day of use. This allows more organisation of your rubbish (which may or
  784. may not be useful) and also allows the auto deletion to be much faster, which
  785. will stop people from shouting at me.
  786.  
  787. 5) Because people complained about my options and radio icons, I've taken
  788. them out. The program now uses whichever icons are standard on your machine.
  789.  
  790. 6) 3d icons have been adopted. I have no idea what the Acorn guidelines are,
  791. so I've adopted those used by Computer Concepts and Simon Huntingdon's
  792. Interface module, since Acorn seem to have copied their icons. (Note: No
  793. relation between S.H. and CC is implied.......(got to cover myself!))
  794.  
  795. 7) The Info window has got sillier.
  796.  
  797. 8) I have added an option to use outline fonts in the menus. I like this, but
  798. some people prefer consistency - that's why it's an option. Also it does NOT
  799. look good in mode 12.... Also, Acorn's latest WIMP actually DOES use an outline
  800. font instead of the system font. (We knew you'd get there in the end, Acorn!)
  801.  
  802. 9) The iconbar sprites change from low-res to high-res (and vice-versa) 
  803. automatically when you change mode (provided you select the option). This is
  804. done simply by *IconSprites, which requires disc access so I made it optional.
  805. If you are using Andrew Hersee's Filer2 with the WimpSprites module, then the
  806. command *WimpSprites will be used instead, which will ensure that the thing
  807. still works.
  808.  
  809. 10) A slightly more sensible (ie non-random) version numbering system has
  810. been introduced.
  811.  
  812. 11) When not doing anything, BlakHole2 takes up less than 1% of available
  813. background time, even with the Clock and Spin selected.
  814.  
  815. 12) Black Hole responds to the Task Manager's "Create Boot File" message. In
  816. other words, if you save a Desktop Boot file from the Task Manager while
  817. Black Hole is loaded, a line will be inserted in the file to run Black Hole.
  818. Thus Black Hole will be run automatically on bootup.
  819. (Thanks to James Miller for this one.)
  820.  
  821. -----------------------------------------------------------------------------
  822.  
  823. Music played while programming:
  824. ===============================
  825.  
  826. Too many to name all, but these and more:
  827. Brian Eno, Magma, King Crimson, Amon Düül II, Jethro Tull, Genesis,
  828. Roxy Music, The Soft Machine, The Incredible String Band, Ozric Tentacles,
  829. Can, Caravan, Led Zeppelin, Van Der Graaf Generator, Deep Purple.....
  830. This probably explains quite a lot. (Some of this stuff is simply not music
  831. to work to. I feel I've comitted sacriledge and this program is it...)
  832.  
  833.  
  834.                             The Fat German, 1992
  835.                   (He's not fat and he's not German either)
  836.               ==================================================
  837.                                                
  838. Mark Greenwood, 122 Miswell Lane, Tring, Herts. HP23 4EU
  839.  
  840.   Thanks to Dave for inventing Fat German.